// Copyright 2021 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------
// Modification history:
// feature: content filter topic
// ------------------------------------------------------------------

#ifndef EDDS_DDS_TOPIC_ICONTENTFILTER_HPP
#define EDDS_DDS_TOPIC_ICONTENTFILTER_HPP

#include <edds/rtps/common/Guid.h>
#include <ertps/rtps/common/SampleIdentity.h>
#include <ertps/rtps/common/SerializedPayload.h>

namespace evbs {
namespace ertps {
namespace rtps {

/**
 * The interface that content filter objects should implement.
 */
struct IContentFilter {
    using SerializedPayload = evbs::ertps::rtps::SerializedPayload_t;
    using GUID_t = evbs::ertps::rtps::GUID_t;
    virtual ~IContentFilter() = default;
    /**
     * Selected information from the cache change that is passed to the content filter object on
     * payload evaluation.
     */
    struct FilterSampleInfo {
        using SampleIdentity = evbs::ertps::rtps::SampleIdentity;

        /// Identity of the sample being filtered.
        SampleIdentity sample_identity;
        /// Identity of a sample related to the one being filtered.
        SampleIdentity related_sample_identity;
    };

    /**
     * Evaluate if a dynamic data should be accepted by certain reader.
     *
     * @param [in]  data         The dynamic data of the sample being evaluated.
     *
     * @return whether the sample should be accepted for the specified reader.
     */
    virtual bool evaluate(void* data) const = 0;
};

}  // namespace rtps
}  // namespace ertps
}  // namespace evbs

#endif  // EDDS_DDS_TOPIC_ICONTENTFILTER_HPP
